home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / C / Applications / Portable Patmos / usr / include / net / if.h < prev    next >
Encoding:
C/C++ Source or Header  |  1994-11-08  |  9.9 KB  |  263 lines  |  [TEXT/R*ch]
  1. /*
  2.  * Copyright (c) 1982, 1986, 1989 Regents of the University of California.
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice, this list of conditions and the following disclaimer in the
  12.  *    documentation and/or other materials provided with the distribution.
  13.  * 3. All advertising materials mentioning features or use of this software
  14.  *    must display the following acknowledgement:
  15.  *    This product includes software developed by the University of
  16.  *    California, Berkeley and its contributors.
  17.  * 4. Neither the name of the University nor the names of its contributors
  18.  *    may be used to endorse or promote products derived from this software
  19.  *    without specific prior written permission.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31.  * SUCH DAMAGE.
  32.  *
  33.  *    from: @(#)if.h    7.11 (Berkeley) 3/19/91
  34.  *    $Id: if.h,v 1.6 1993/12/10 11:45:25 cgd Exp $
  35.  */
  36.  
  37. #ifndef _NET_IF_H_
  38. #define _NET_IF_H_
  39.  
  40. /*
  41.  * Structures defining a network interface, providing a packet
  42.  * transport mechanism (ala level 0 of the PUP protocols).
  43.  *
  44.  * Each interface accepts output datagrams of a specified maximum
  45.  * length, and provides higher level routines with input datagrams
  46.  * received from its medium.
  47.  *
  48.  * Output occurs when the routine if_output is called, with three parameters:
  49.  *    (*ifp->if_output)(ifp, m, dst)
  50.  * Here m is the mbuf chain to be sent and dst is the destination address.
  51.  * The output routine encapsulates the supplied datagram if necessary,
  52.  * and then transmits it on its medium.
  53.  *
  54.  * On input, each interface unwraps the data received by it, and either
  55.  * places it on the input queue of a internetwork datagram routine
  56.  * and posts the associated software interrupt, or passes the datagram to a raw
  57.  * packet input routine.
  58.  *
  59.  * Routines exist for locating interfaces by their addresses
  60.  * or for locating a interface on a certain network, as well as more general
  61.  * routing and gateway routines maintaining information used to locate
  62.  * interfaces.  These routines live in the files if.c and route.c
  63.  */
  64. #ifndef _TIME_ /*  XXX fast fix for SNMP, going away soon */
  65. #ifdef KERNEL
  66. #include "../sys/time.h"
  67. #else
  68. #include <sys/time.h>
  69. #endif
  70. #endif
  71.  
  72. /*
  73.  * Structure defining a queue for a network interface.
  74.  *
  75.  * (Would like to call this struct ``if'', but C isn't PL/1.)
  76.  */
  77.  
  78. struct ifnet {
  79.     char    *if_name;        /* name, e.g. ``en'' or ``lo'' */
  80.     short    if_unit;        /* sub-unit for lower level driver */
  81.     short    if_mtu;            /* maximum transmission unit */
  82.     short    if_flags;        /* up/down, broadcast, etc. */
  83.     short    if_timer;        /* time 'til if_watchdog called */
  84.     int    if_metric;        /* routing metric (external only) */
  85.     struct    ifaddr *if_addrlist;    /* linked list of addresses per if */
  86.     struct    ifqueue {
  87.         struct    mbuf *ifq_head;
  88.         struct    mbuf *ifq_tail;
  89.         int    ifq_len;
  90.         int    ifq_maxlen;
  91.         int    ifq_drops;
  92.     } if_snd;            /* output queue */
  93. /* procedure handles */
  94.     int    (*if_init)();        /* init routine */
  95.     int    (*if_output)();        /* output routine (enqueue) */
  96.     int    (*if_start)();        /* initiate output routine */
  97.     int    (*if_done)();        /* output complete routine */
  98.     int    (*if_ioctl)();        /* ioctl routine */
  99.     int    (*if_reset)();        /* bus reset routine */
  100.     int    (*if_watchdog)();    /* timer routine */
  101. /* generic interface statistics */
  102.     int    if_ipackets;        /* packets received on interface */
  103.     int    if_ierrors;        /* input errors on interface */
  104.     int    if_opackets;        /* packets sent on interface */
  105.     int    if_oerrors;        /* output errors on interface */
  106.     int    if_collisions;        /* collisions on csma interfaces */
  107. /* end statistics */
  108.     struct    ifnet *if_next;
  109.     u_char    if_type;        /* ethernet, tokenring, etc */
  110.     u_char    if_addrlen;        /* media address length */
  111.     u_char    if_hdrlen;        /* media header length */
  112.     u_char    if_index;        /* numeric abbreviation for this if  */
  113. /* more statistics here to avoid recompiling netstat */
  114.     struct    timeval if_lastchange;    /* last updated */
  115.     int    if_ibytes;        /* total number of octets received */
  116.     int    if_obytes;        /* total number of octets sent */
  117.     int    if_imcasts;        /* packets received via multicast */
  118.     int    if_omcasts;        /* packets sent via multicast */
  119.     int    if_iqdrops;        /* dropped on input, this interface */
  120.     int    if_noproto;        /* destined for unsupported protocol */
  121.     int    if_baudrate;        /* linespeed */
  122.         int    if_pcount;        /* number of promiscuous listeners */
  123. };
  124.  
  125. #define    IFF_UP        0x1        /* interface is up */
  126. #define    IFF_BROADCAST    0x2        /* broadcast address valid */
  127. #define    IFF_DEBUG    0x4        /* turn on debugging */
  128. #define    IFF_LOOPBACK    0x8        /* is a loopback net */
  129. #define    IFF_POINTOPOINT    0x10        /* interface is point-to-point link */
  130. #define    IFF_NOTRAILERS    0x20        /* avoid use of trailers */
  131. #define    IFF_RUNNING    0x40        /* resources allocated */
  132. #define    IFF_NOARP    0x80        /* no address resolution protocol */
  133. /* next two not supported now, but reserved: */
  134. #define    IFF_PROMISC    0x100        /* receive all packets */
  135. #define    IFF_ALLMULTI    0x200        /* receive all multicast packets */
  136. #define    IFF_OACTIVE    0x400        /* transmission in progress */
  137. #define    IFF_SIMPLEX    0x800        /* can't hear own transmissions */
  138. #define    IFF_LINK0    0x1000        /* per link layer defined bit */
  139. #define    IFF_LINK1    0x2000        /* per link layer defined bit */
  140. #define    IFF_LINK2    0x4000        /* per link layer defined bit */
  141. #define IFF_MULTICAST    0x8000        /* supports multicast */
  142.  
  143. /* flags set internally only: */
  144. #define IFF_CANTCHANGE \
  145.     (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE| \
  146.     IFF_SIMPLEX|IFF_MULTICAST)
  147.  
  148. /*
  149.  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
  150.  * input routines have queues of messages stored on ifqueue structures
  151.  * (defined above).  Entries are added to and deleted from these structures
  152.  * by these macros, which should be called with ipl raised to splimp().
  153.  */
  154. #define    IF_QFULL(ifq)        ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
  155. #define    IF_DROP(ifq)        ((ifq)->ifq_drops++)
  156. #define    IF_ENQUEUE(ifq, m) { \
  157.     (m)->m_nextpkt = 0; \
  158.     if ((ifq)->ifq_tail == 0) \
  159.         (ifq)->ifq_head = m; \
  160.     else \
  161.         (ifq)->ifq_tail->m_nextpkt = m; \
  162.     (ifq)->ifq_tail = m; \
  163.     (ifq)->ifq_len++; \
  164. }
  165. #define    IF_PREPEND(ifq, m) { \
  166.     (m)->m_nextpkt = (ifq)->ifq_head; \
  167.     if ((ifq)->ifq_tail == 0) \
  168.         (ifq)->ifq_tail = (m); \
  169.     (ifq)->ifq_head = (m); \
  170.     (ifq)->ifq_len++; \
  171. }
  172. #define    IF_DEQUEUE(ifq, m) { \
  173.     (m) = (ifq)->ifq_head; \
  174.     if (m) { \
  175.         if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
  176.             (ifq)->ifq_tail = 0; \
  177.         (m)->m_nextpkt = 0; \
  178.         (ifq)->ifq_len--; \
  179.     } \
  180. }
  181.  
  182. #define    IFQ_MAXLEN    50
  183. #define    IFNET_SLOWHZ    1        /* granularity is 1 second */
  184.  
  185. /*
  186.  * The ifaddr structure contains information about one address
  187.  * of an interface.  They are maintained by the different address families,
  188.  * are allocated and attached when an address is set, and are linked
  189.  * together so all addresses for an interface can be located.
  190.  */
  191. struct ifaddr {
  192.     struct    sockaddr *ifa_addr;    /* address of interface */
  193.     struct    sockaddr *ifa_dstaddr;    /* other end of p-to-p link */
  194. #define    ifa_broadaddr    ifa_dstaddr    /* broadcast address interface */
  195.     struct    sockaddr *ifa_netmask;    /* used to determine subnet */
  196.     struct    ifnet *ifa_ifp;        /* back-pointer to interface */
  197.     struct    ifaddr *ifa_next;    /* next address for interface */
  198.     int    (*ifa_rtrequest)();    /* check or clean routes (+ or -)'d */
  199.     struct     rtentry *ifa_rt;    /* ??? for ROUTETOIF */
  200.     u_short    ifa_flags;        /* mostly rt_flags for cloning */
  201.     u_short    ifa_llinfolen;        /* extra to malloc for link info */
  202. };
  203. #define IFA_ROUTE    RTF_UP        /* route installed */
  204. /*
  205.  * Interface request structure used for socket
  206.  * ioctl's.  All interface ioctl's must have parameter
  207.  * definitions which begin with ifr_name.  The
  208.  * remainder may be interface specific.
  209.  */
  210. struct    ifreq {
  211. #define    IFNAMSIZ    16
  212.     char    ifr_name[IFNAMSIZ];        /* if name, e.g. "en0" */
  213.     union {
  214.         struct    sockaddr ifru_addr;
  215.         struct    sockaddr ifru_dstaddr;
  216.         struct    sockaddr ifru_broadaddr;
  217.         short    ifru_flags;
  218.         int    ifru_metric;
  219.         caddr_t    ifru_data;
  220.     } ifr_ifru;
  221. #define    ifr_addr    ifr_ifru.ifru_addr    /* address */
  222. #define    ifr_dstaddr    ifr_ifru.ifru_dstaddr    /* other end of p-to-p link */
  223. #define    ifr_broadaddr    ifr_ifru.ifru_broadaddr    /* broadcast address */
  224. #define    ifr_flags    ifr_ifru.ifru_flags    /* flags */
  225. #define    ifr_metric    ifr_ifru.ifru_metric    /* metric */
  226. #define    ifr_data    ifr_ifru.ifru_data    /* for use by interface */
  227. };
  228.  
  229. struct ifaliasreq {
  230.     char    ifra_name[IFNAMSIZ];        /* if name, e.g. "en0" */
  231.     struct    sockaddr ifra_addr;
  232.     struct    sockaddr ifra_broadaddr;
  233.     struct    sockaddr ifra_mask;
  234. };
  235.  
  236. /*
  237.  * Structure used in SIOCGIFCONF request.
  238.  * Used to retrieve interface configuration
  239.  * for machine (useful for programs which
  240.  * must know all networks accessible).
  241.  */
  242. struct    ifconf {
  243.     int    ifc_len;        /* size of associated buffer */
  244.     union {
  245.         caddr_t    ifcu_buf;
  246.         struct    ifreq *ifcu_req;
  247.     } ifc_ifcu;
  248. #define    ifc_buf    ifc_ifcu.ifcu_buf    /* buffer address */
  249. #define    ifc_req    ifc_ifcu.ifcu_req    /* array of structures returned */
  250. };
  251.  
  252. #ifdef KERNEL
  253. #include "../net/if_arp.h"
  254. struct    ifqueue rawintrq;        /* raw packet input queue */
  255. struct    ifnet *ifnet;
  256. struct    ifaddr *ifa_ifwithaddr(), *ifa_ifwithnet();
  257. struct    ifaddr *ifa_ifwithdstaddr();
  258. #else KERNEL
  259. #include <net/if_arp.h>
  260. #endif KERNEL
  261.  
  262. #endif /* !_NET_IF_H_ */
  263.